// Copyright 2023 Huawei Cloud Computing Technology Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef VMIBUF_H
#define VMIBUF_H

#include <cstdlib>
#include <cstdint>

struct VmiBuffer {
    /**
     * @brief: constuctor
     */
    VmiBuffer() = default;

    /**
     * @brief: constuctor
     * @param [in] pointer: pointer
     * @param [in] bufferSize: bufferSize
     */
    VmiBuffer(uint8_t* pointer, const size_t bufferSize);

    /**
     * @brief: get pointer
     * @return: pointer
     */
    uint8_t* GetPointer() const;

    /**
     * @brief: get size
     * @return: size
     */
    size_t GetSize() const;

    /**
     * @brief: alloc memory
     * @param [in] bufferSize: bufferSize
     * @return: return buffer object
     */
    static VmiBuffer Alloc(size_t bufferSize);

    /**
     * @brief: free memmory
     */
    void Free();
    uint8_t* m_pointer;
    size_t m_bufferSize;
};

/**
 * @brief: alloc memory
 * @param [in] size: memory size
 * @return: memory pointer
 */
extern void* VmiAllocBuffer(const unsigned int size);

/**
 * @brief: free memory
 * @param [in] size: memory pointer
 */
extern void VmiFreeBuffer(void* buf);

#endif
